import request from "@/utils/request";

const USERSTUDYRECORDS_BASE_URL = "/api/v1/user-study-records";

const UserStudyRecordsAPI = {
    /** 获取用户学习记录分页数据 */
    getPage(queryParams?: UserStudyRecordsPageQuery) {
        return request<any, PageResult<UserStudyRecordsPageVO[]>>({
            url: `${USERSTUDYRECORDS_BASE_URL}/page`,
            method: "get",
            params: queryParams,
        });
    },
    /**
     * 获取用户学习记录表单数据
     *
     * @param id 用户学习记录ID
     * @returns 用户学习记录表单数据
     */
    getFormData(id: number) {
        return request<any, UserStudyRecordsForm>({
            url: `${USERSTUDYRECORDS_BASE_URL}/${id}/form`,
            method: "get",
        });
    },

    /**
     *  添加用户学习记录
     *
     *  @param data 用户学习记录表单数据
     */
    add(data: UserStudyRecordsForm) {
        return request({
            url: `${USERSTUDYRECORDS_BASE_URL}`,
            method: "post",
            data: data,
        });
    },

    /**
     * 更新用户学习记录
     *
     * @param id 用户学习记录ID
     * @param data 用户学习记录表单数据
     */
     update(id: number, data: UserStudyRecordsForm) {
        return request({
            url: `${USERSTUDYRECORDS_BASE_URL}/${id}`,
            method: "put",
            data: data,
        });
    },

    /**
     * 批量删除用户学习记录，多个以英文逗号(,)分割
     *
     * @param ids 用户学习记录ID字符串，多个以英文逗号(,)分割
     */
     deleteByIds(ids: string) {
        return request({
            url: `${USERSTUDYRECORDS_BASE_URL}/${ids}`,
            method: "delete",
        });
    }
}

export default UserStudyRecordsAPI;

/** 用户学习记录分页查询参数 */
export interface UserStudyRecordsPageQuery extends PageQuery {
    /** 学生ID */
    userId?: number;
    /** 单词ID */
    wordId?: number;
    /** 单元名 */
    unitName?: string;
    /** 状态 */
    status?: number;
    /** 来源 */
    source?: string;
    /** 来源字段 */
    sourceFrom?: string;
}

/** 用户学习记录表单对象 */
export interface UserStudyRecordsForm {
    /** 学习记录ID */
    id?:  number;
    /** 学生ID */
    userId?:  number;
    /** 系列ID */
    seriesId?:  number;
    /** 教材ID */
    programId?:  number;
    /** 单词ID */
    wordId?:  number;
    /** 所属单元ID */
    unitId?:  number;
    /** 单元名 */
    unitName?:  string;
    /** 状态 */
    status?:  number;
    /** 来源 */
    source?:  string;
    /** 学习ID */
    studyId?:  number;
    /** 来源字段 */
    sourceFrom?:  string;
    /** 拼写类型 */
    spellType?:  number;
    /** 是否测试单词 */
    isTestWord?:  number;
    /** 创建者 */
    createUser?:  number;
    /** 更新者 */
    updateUser?:  number;
}

/** 用户学习记录分页对象 */
export interface UserStudyRecordsPageVO {
    /** 学习记录ID */
    id?: number;
    /** 学生ID */
    userId?: number;
    /** 系列ID */
    seriesId?: number;
    /** 教材ID */
    programId?: number;
    /** 单词ID */
    wordId?: number;
    /** 所属单元ID */
    unitId?: number;
    /** 单元名 */
    unitName?: string;
    /** 状态 */
    status?: number;
    /** 来源 */
    source?: string;
    /** 学习ID */
    studyId?: number;
    /** 来源字段 */
    sourceFrom?: string;
    /** 拼写类型 */
    spellType?: number;
    /** 是否测试单词 */
    isTestWord?: number;
    /** 创建者 */
    createUser?: number;
    /** 更新者 */
    updateUser?: number;
}
